KsError enumeration

The errors of a method.

Namespace: IntervalZero.KINGSTAR.Base

Assembly: IntervalZero.KINGSTAR.Base (in IntervalZero.KINGSTAR.Base.dll) Version: 4.4.0.0

Syntax

C#VB 
public enum KsError
Public Enum KsError

Members

Normal states

Member name Value Description
errNoError 0 The command succeeded.
errBusy 1 The function or feature is busy.

API errors

Name Value Meaning
errNullParameter 0x1000 The output is invalid because one of the parameter is a null pointer.
errWrongParameter 0x1001 One of the parameters has been rejected.
errSubsystemNotRunning 0x1002 The KINGSTAR Subsystem is not running.
errLinkBusy 0x1003 The link with Windows is busy.
errNoLicense 0x1004 No license for the feature.
errWrongEnvironment 0x1005 The command can't be run in the current condition.
errVariableUnavailable 0x1006 The variable is not mapped to PDO.
errVariableSizeIncoherent 0x1007 The size given for the variable in the database does not make sense.
errUserCancelled 0x1008 The command was cancelled by the user.
errTimeout 0x1009 The command is sent but the system does't respond.
errFeatureUnavailable 0x100A The functionality is unavailable.
errFunctionInUse 0x100B The function is in use.
errSlaveRejected 0x100C The slave rejects the command.
errNotDefined 0x100D The object is not initialized.
errWrongSubsystemState 0x100E

The current Subsystem state doesn't allow this command to be run.
errWrongSlaveState 0x100F The current slave state doesn't allow this command to be run.

Startup errors

Name Value Meaning
errNoNicSelected 0x2000 No network interface card is selected.
errNicNotFound 0x2001 No network interface card.
errLinkDisconnected 0x2002 The network interface card is not connected to any hardware.
errNoSlave 0x2003 No slave drives.
errUnknownSlave 0x2004 The slave is unknown.
errNoMemory 0x2005 The memory allocated for KINGSTAR is not enough.
errNoFile 0x2006 IntervalZeroDevices database is not found.
errIncorrectFormat 0x2007 The content of IntervalZeroDevices database doesn't use KINGSTAR's format.
errWrongDeviceCount 0x2008 The number of devices on the bus does not match the number of devices scanned.
errInitFailed 0x2009 An EtherCAT slave can't enter the Init state.
errPreOpFailed 0x200A An EtherCAT slave can't enter the Pre-Operational state.
errSafeOpFailed 0x200B An EtherCAT slave can't enter the Safe-Operational state.
errOpFailed 0x200C An EtherCAT slave can't enter the Operational state.
errDcFailed 0x200D An EtherCAT slave's distributed clock can't be configured.
errMdpFailed 0x200E Scanning the modules attached to a coupler on the network failed.
errFailed 0x200F The method failed.
errFileVersionNotSupported 0x2010 The file was built with a different version of KINGSTAR and cannot be read.
errThreadCreation 0x2011 Failed to create a thread.
errCabling 0x2012 The cabling of EtherCAT hardware is incorrect.
errPacketLost 0x2013 A critical packet was lost.
errInvalidCycleTime 0x2014 The requested cycle time conflicts with the HAL period.
errSystemOverload 0x2015 The system is overloaded.
errWatchdog 0x2016 The watchdog timed out.
errUnexpectedData 0x2017 An incoming packet contains unexpected data.
errSlaveState 0x2018 A slave state is incorrect.
errConfigurationMismatch 0x2019 The slaves on the bus don't match the configuration file.

Motion errors

Name Value Meaning
errWrongControlMode 0x3000 The method can't be used in this control mode.
errCommandBufferFull 0x3001 The command buffer is full. The buffer can contain up to 512 commands.
errInvalidHandle 0x3002 The specified handle doesn't correspond to any command in the Subsystem.
errWrongAxisState 0x3003 The current axis state doesn't allow this command to be run.
errNoSensorDefined 0x3004 The homing method is used without defining the home sensor.
errFollowingError 0x3005 The maximum following error is reached. The motion is stopped and the axis is disabled.
errMinimumLimit 0x3006 The maximum travel distance in the negative direction is reached. The motion is stopped.
errMaximumLimit 0x3007 The maximum travel distance in the positive direction is reached. The motion is stopped.
errCommandJump 0x3008 The new target position is too far from the previous target position. The motion is stopped and the axis is disabled.
errWrongGroupState 0x3009 The current group state doesn't allow this command to be run.

errUnstableTuning

0x300A

The tuning leads to an unstable state.

errStaleTuning

0x300B

The tuning counts go over the limit before finding a suitable PID setting.

SDO errors

Member name Value Description
errSdoToggleBit 0x4000 Toggle bit not changed.
errSdoTimeout 0x4001 SDO protocol timeout.
errSdoCommandSpecifier 0x4002 Client/Server command specifier not valid or unknown.
errSdoOutOfMemory 0x4003 Out of memory.
errSdoUnsupportedAccess 0x4004 Unsupported access to an object.
errSdoWriteOnly 0x4005 Attempt to read to a write-only object.
errSdoReadOnly 0x4006 Attempt to write to a read-only object.
errSdoSubindexReadOnly 0x4007 Subindex cannot be written. SI0 must be zero for write access.
errSdoNoCompleteAccess 0x4008 SDO Complete Access not supported for objects of variable length such as enum object types.
errSdoObjectTooLong 0x4009 Object length exceeds mailbox size.
errSdoObjectInPdo 0x400A Object mapped to RxPDO. SDO Download blocked.
errSdoObjectNotExist 0x400B The object doesn't exist in the object directory.
errSdoNoPdoMapping 0x400C The object can't be mapped into PDO.
errSdoPdoLengthExceeded 0x400D The number and length of the objects to be mapped would exceed the PDO length.
errSdoParameterIncompatible 0x400E General parameter incompatibility reason.
errSdoInternalIncompatible 0x400F General internal incompatibility in the device.
errSdoHardwareError 0x4010 Access failed due to a hardware error.
errSdoLengthIncorrect 0x4011 Data type doesn't match. Length of service parameter doesn't match.
errSdoLengthTooHigh 0x4012 Data type doesn't match. Length of service parameter too high.
errSdoLengthTooLow 0x4013 Data type doesn't match. Length of service parameter too low.
errSdoSubindexNotExist 0x4014 Subindex doesn't exist.
errSdoValueOutOfRange 0x4015 Value range of parameter exceeded (only for write access).
errSdoValueTooHigh 0x4016 Value of parameter written too high.
errSdoValueTooLow 0x4017 Value of parameter written too low.
errSdoMaxBelowMin 0x4018 The maximum value is less than the minimum value.
errSdoGeneralError 0x4019 General error.
errSdoCannotTransfer 0x401A Data can't be transferred or stored to the application.
errSdoCannotTransferLocal 0x401B Data can't be transferred or stored to the application because of local control.
errSdoWrongState 0x401C Data can't be transferred or stored to the application because of the present device state.
errSdoDictionaryNotAvailable 0x401D Object dictionary dynamic generation fails or no object dictionary is present.

OPC UA errors

Member name Value Description
errOpcDisconnected 0x5000 No open connection to the runtime.
errOpcUserAccessDenied 0x5001 The function is not available to this user role.
errOpcServiceException 0x5002 The OPC function call failed.
errOpcNodeNotFound 0x5003 The function does not exist on this runtime.
errOpcTimeout 0x5004 Time-out for the remote call.

errOpcFileInUse

0x5005

The target file is currently used by another call and cannot be written.

Management service errors

Member name Value Description
errManagementServiceEndpointNotFound 0x6000

The issue commonly occurs when the 'KINGSTAROpcUaService' Windows service is not operational or fails to initiate due to a port conflict. To address this problem, follow these steps:

  1. Re-configure the port number of the Management Service.
  2. The 'KINGSTAROpcUaService' should start automatically upon reboot.
errManagementServiceConnectionTimeout 0x6001

Failed to connect to the Management Service due to a connection timeout. This issue often arises when all available connections are currently occupied by other APIs or Subsystem instances. To prevent this, ensure that IntervalZero.KINGSTAR.Local.Api.Api.Dispose is called after the use of each API instance. Similarly, IntervalZero.KINGSTAR.Local.Class.Subsystem.Dispose should be used to properly release Subsystem instances when they are no longer needed.

For immediate resolution, you can either terminate the processes that are using KINGSTAR APIs or restart the 'KINGSTAROpcUaService' Windows service to free-up the connections.
errManagementServiceConnectionFailed 0x6002 Failed to connect to the Management Service.

See also

IntervalZero.KINGSTAR.Base Namespace